概述
SView Designer Control为OCX控件提供三维模型基本的浏览、模型属性操作、基本三维对象操作、动画播放等功能的实现接口,可实现基本的 三维模型展示功能,以便于用户个性化定制属于自己的产品。文档主要介绍了OCX控件提供的接口说明。SView Designer Control控件集成说明的介绍请查看SView Designer Control 集成说明文档。
接口列表
基本浏览
打开本地文件
方法
void Open(BSTR fileName)
说明
打开本地文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
fileName | 是 | 本地文件路径。 |
返回值
TRUE-成功FALSE-失败
备注
D:\\1.svl 打开D盘下的1.svl文件
关闭模型文件
方法
void Close(VARIANT_BOOL bSaveFile)
说明
关闭模型文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
bSaveFile | 是 | 是否保存文件 |
返回值
无
备注
无
保存模型
方法
VARIANT_BOOL Save(BSTR filePath, BOOL bDistribution)
说明
将当前模型保存到指定目录
参数
参数 | 是否必须 | 说明 |
---|---|---|
filePath | 是 | 文件保存路径 |
bDistribution | 是 | 是否分散存储 |
返回值
TRUE-成功FALSE-失败
备注
无
选择模型
方法
void SelectModels(BSTR objID, VARIANT_BOOL bDeslectAll)
说明
设置选择的模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
objid | 是 | 输入参数,模型实例ID (如:PATH|0|2;PATH|0|5 多个用分号隔开) |
bDeslectAll | 是 | 是否取消已有选择 |
返回值
void
备注
无
获取选择的模型
方法
BSTR GetSelectedModels()
说明
获取选择的模型
参数
无
返回值
选择模型ID数组(如:PATH|0|3,ELBOW_FIT;PATH|0|4,CLAMP)
备注
无
显隐模型
方法
void SetModelVisibility(BSTR plcPath,VARIANT_BOOL bshow)
说明
根据模型实例ID,显隐模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
plcPath | 是 | 模型实例路径(多个用逗号隔开,如PATH|0|1,PATH|0|3) |
bshow | 是 | 显示/隐藏状态 |
返回值
void
备注
无
设置模型颜色
方法
void SetModelColor(LONG objColor, BSTR plcPath)
说明
设置模型颜色
参数
参数 | 是否必须 | 说明 |
---|---|---|
objColor | 是 | 要改变的颜色 |
svlPath | 是 | 对象ID(如:PATH|0|1) |
返回值
void
备注
根据名称设置模型的颜色
方法
void SetModelColorByName(LONG objColor,BSTR objName)
说明
根据名称设置模型的颜色
参数
参数 | 是否必须 | 说明 |
---|---|---|
objColor | 是 | 设置的颜色值 |
objName | 是 | 模型名称(多个用分号隔开) |
返回值
void
备注
无
获取视图列表
方法
BSTR GetModelViews(void)
说明
获取视图列表
参数
无
返回值
回视图ID和名称组合字符串;格式如下:ID,名称;ID,名称。
备注
无
根据视图ID设置当前视图
方法
void SetModelViewByID(LONG viewID)
说明
根据视图ID设置当前视图
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
返回值
void
备注
无
获取当前视图ID
方法
LONG GetCurrentModelView(void)
说明
获取当前视图ID。
参数
无
返回值
当前视图ID
备注
无
显示默认视图
方法
void ShowDefaultView()
说明
显示默认视图
参数
无
返回值
void
备注
无
添加模型
方法
BSTR AddModel(BSTR strFilePath, BSTR strParentPlcID)
说明
添加模型接口
参数
参数 | 是否必须 | 说明 |
---|---|---|
strFilePath | 是 | 插入的模型文件路径 |
strParentPlcID | 是 | 父对象配置路径,如:PATH|0|3 |
返回值
新增模型路径
备注
无
删除模型
方法
void DeleteModelById(BSTR ids)
说明
删除模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
ids | 是 | 模型ID,多个中间用 ";"分割(如:PATH|0|2;PATH|0|5) |
返回值
无
备注
无
刷新视口
方法
VARIANT_BOOL RefreshWindow()
说明
刷新视口
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
根据属性名称获取指定零件的属性值
方法
BSTR ModelGetProperty(BSTR plcPath, BSTR propertyName)
说明
根据属性名称获取指定零件的属性值
参数
参数 | 是否必须 | 说明 |
---|---|---|
plcPath | 是 | 零组件配置路径(如:PATH|0|2) |
PropertyName | 是 | 属性名称 |
返回值
属性值
备注
无
添加属性
方法
VARIANT_BOOL AddProperty(BSTR plcPath,BSTR PropertyName,BSTR PropertyValue)
说明
添加属性
参数
参数 | 是否必须 | 说明 |
---|---|---|
plcPath | 是 | 零组件配置路径。 |
PropertyName | 是 | 属性名称 |
PropertyValue | 是 | 属性值 |
返回值
TRUE-成功FASLE-失败
备注
无
编辑属性
方法
VARIANT_BOOL EditProperty(BSTR plcPath,BSTR PropertyName,BSTR PropertyValue)
说明
编辑属性,改变该属性名下的属性值
参数
参数 | 是否必须 | 说明 |
---|---|---|
plcPath | 是 | 零组件配置路径 |
PropertyName | 是 | 属性名称 |
PropertyValue | 是 | 属性值 |
返回值
TRUE-成功FASLE-失败
备注
无
生成快照
方法
VARIANT_BOOL CreateSnap(BSTR filePath, BSTR fileType, VARIANT_BOOL bCover, LONG width, LONG height)
说明
生成快照
参数
参数 | 是否必须 | 说明 |
---|---|---|
filePath | 是 | 快照路径 |
fileType | 是 | 文件格式类型 |
bCover | 是 | 是否覆盖 |
width | 是 | 快照宽度 |
height | 是 | 快照高度 |
返回值
TRUE-成功FASLE-失败
备注
无
自定义截图
方法
VARIANT_BOOL CustomScreenShot()
说明
自定义截图
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
导出BOM装配结构到指定路径
方法
VARIANT_BOOL BomToJson(BSTR filePath)
说明
导出BOM装配结构到指定路径
参数
参数 | 是否必须 | 说明 |
---|---|---|
filePath | 是 | BOM文件保存路径 |
返回值
TRUE-成功FASLE-失败
备注
无
显示关于对话框
方法
void AboutBox()
说明
显示关于对话框
参数
无
返回值
void
备注
无
设置是否显示选中模型的包围盒标志
方法
void ShowBox(VARIANT_BOOL bShow)
说明
设置是否显示选中模型的包围盒标志
参数
参数 | 是否必须 | 说明 |
---|---|---|
bShow | 是 | 显示/隐藏标志 |
返回值
void
备注
无
选中模型事件
事件
OnModelSelectedChanged(BSTR svlPath, VARIANT_BOOL isSelected)
说明
选中模型事件
参数
参数 | 是否必须 | 说明 |
---|---|---|
svlPath | 是 | 拾取零件的配置路径 |
isSelected | 是 | 拾取或取消拾取 |
返回值
void
备注
无
鼠标事件
事件
void OnMouseEven(int mouseKey)
说明
鼠标事件
参数
参数 | 是否必须 | 说明 |
---|---|---|
mouseKey | 是 |
1-单击左键 2-单击右键 3-双击左键 4-双击右键 |
返回值
void
备注
按下鼠标时触发,只实现了双击事件
打开文件后触发事件
事件
void OnFileLoadEndEvent(BSTR fileLoadInfo)
说明
打开文件后触发事件
参数
参数 | 是否必须 | 说明 |
---|---|---|
fileLoadInfo | 是 | svlx文件路径 |
返回值
void
备注
无
动画
播放动画
方法
void PlayStep(LONG playMode, VARIANT_BOOL bReverse)
说明
播放动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
playMode | 是 | 0-无 1-播放当前步骤 2-从当前步骤开始播放 3-播放当前过程 4-从当前过程开始播放 5-播放全部动画 6-随机播放动画 |
bReverse | 是 | 是否为倒播 |
返回值
void
备注
无
创建新的步骤
方法
BSTR AnimationCreateStep()
说明
创建新的步骤
参数
无
返回值
步骤ID,如:0|1(0代表过程ID,1代表步骤ID)
备注
无
删除指定步骤ID的动画
方法
void AnimationDeleteStep(BSTR stepID)
说明
删除指定步骤ID的动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
stepID | 是 | 由过程ID和步骤ID组成,如:0|1(0代表过程ID,1代表步骤ID) |
返回值
void
备注
无
设置成当前活动的步骤
方法
void AnimationSetCurStep(BSTR stepID)
说明
设置成当前活动的步骤
参数
参数 | 是否必须 | 说明 |
---|---|---|
stepID | 是 | 由过程ID和步骤ID组成,如:0|1(0代表过程ID,1代表步骤ID) |
返回值
void
备注
无
更新当前步骤
方法
void AnimationUpdateCurStep(void)
说明
更新当前步骤
参数
无
返回值
void
备注
无
PMI
获取选择的PMI
方法
BSTR GetSelectPMI()
说明
获取选择的PMI
参数
无
返回值
选择的PMI ID集合中间用";"号分割。多行文本用"\r\n"分割
备注
无
选择PMI
方法
void SelectPMI(BSTR ids, VARIANT_BOOL bDeselectAll)
说明
选择PMI
参数
参数 | 是否必须 | 说明 |
---|---|---|
ids | 是 | 选择的PMI ID集合。多个PMI中间用";"号分割,多行文本用"\r\n"分割 |
bDeselectAll | 是 | 拾取前是否取消选中 |
返回值
void
备注
无
设置PMI显隐状态
方法
void SetPMIsVisibity(BSTR ids, VARIANT_BOOL bShow)
说明
设置PMI显隐状态
参数
参数 | 是否必须 | 说明 |
---|---|---|
ids | 是 | 选择的PMI ID集合。多个PMI中间用";"号分割,多行文本用"\r\n"分割 |
bShow | 是 | 显隐状态 |
返回值
void
备注
无
显示隐藏所有的PMI
方法
void ShowHideAllPMI(bool bShow)
说明
显示隐藏所有的PMI
参数
参数 | 是否必须 | 说明 |
---|---|---|
bShow | 是 | 显示隐藏所有的PMI |
返回值
void
备注
无
根据PMI类型名称获取该类型所有PMI
方法
BSTR GetPMIInfo(BSTR propertyName)
说明
根据PMI类型名称获取该类型所有PMI
参数
参数 | 是否必须 | 说明 |
---|---|---|
propertyName | 是 | PMI类型名称 "COMPONENT_SN"代表零件序号PMI名称;"TORQUE"代表扭矩PMI名称;"GAP"表示间隙;""获取所有PMI信息 |
返回值
总装下所有该类型的PMI,格式为"配置路径1:PMI名称;配置路径2:PMI名称2"。当输入为"",获取所有PMI信息,格式为"id:内容,显隐状态;id:内容,显隐状态"。多行文本用"\r\n"分割
备注
目前,只支持“COMPONENT_SN”类型和“”
创建零组件标注
方法
VARIANT_BOOL CreateComponentNote()
说明
创建零组件标注
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
创建零组件序号标注
方法
VARIANT_BOOL CreateComponentSNNote()
说明
创建零组件序号标注
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
根据ID获取PMI显隐状态
方法
BSTR GetPMIStateById(BSTR PMIId)
说明
根据ID获取PMI显隐状态
参数
参数 | 是否必须 | 说明 |
---|---|---|
PMIId | 是 | PMI ID集合。中间用";"号分割。 |
返回值
PMI的显示隐藏状态,格式为"PMIID1,显示隐藏状态1;PMIID2,显示隐藏状态2",例如:"id,true;id,false;"
备注
无
创建零组件标注前事件
事件
void OnCreateCompNameBeginEvent()
说明
创建零组件标注前事件,在执行创建零组件标注时,创建标注前触发
参数
无
返回值
无
备注
1)在执行工具栏命令"零组件标注"时响应2)接收事件后,若需后续处理,请调用接口CreateComponentNote。
创建零组件序号标注前事件
事件
void OnCreateSerialNumberBeginEvent()
说明
创建零组件序号标注前事件,在执行创建零组件序号标注时,创建序号前触发
参数
无
返回值
无
备注
1)在执行工具栏命令"序号标注-零组件"时响应2)接收事件后,若需后续处理,请调用接口CreateComponentSNNote。
选中PMI事件
事件
void OnPMISelectedChanged(INT iPMIId)
说明
选中PMI时触发
参数
参数 | 是否必须 | 说明 |
---|---|---|
iPMIId | 是 | pmi ID |
返回值
无
备注
1)在选择PMI时响应的事件处理2)接收事件后,若需后续处理,请调用接口OnSelectPMIEvent。
批注
设置用户信息
方法
void SetUser(BSTR userName, BSTR departmentName, BSTR roleName)
说明
设置当前选中批注的用户信息
参数
参数 | 是否必须 | 说明 |
---|---|---|
userName | 是 | 用户名称 |
departmenterName | 是 | 部门名称 |
roleName | 是 | 角色名称 |
返回值
void
备注
无
获取用户信息
方法
BSTR GetUser(void)
说明
获取当前选中批注的用户信息
参数
无
返回值
用户名;部门名称;开发
备注
无
新建批注
方法
void CreateNote()
说明
新建批注
参数
无
返回值
void
备注
无
编辑选中的批注
方法
void EditNote()
说明
编辑选中的批注
参数
无
返回值
void
备注
无
获取选中的批注信息
方法
BSTR GetSelectedUserNotes()
说明
获取选中的批注信息
参数
无
返回值
选中的批注列表字符串。格式(ID1:批注信息1;ID2:批注信息2)。选择多个用分号隔开,如:34:2|ssswasdsdsaxc;18:2|dsafsaf
备注
无
选中批注
方法
void SelectUserNotes(BSTR userNoteIds)
说明
选中批注
参数
参数 | 是否必须 | 说明 |
---|---|---|
userNoteIds | 是 | 批注ID,多个用';'间隔 |
返回值
void
备注
无
删除批注
方法
VARIANT_BOOL DeleteNote(BSTR noteIds)
说明
删除批注
参数
参数 | 是否必须 | 说明 |
---|---|---|
bstrID | 是 | 批注ID,多个用';'间隔 |
成功与否
void
备注
无